Skip to main content

Verify identity using international passport

POST /api/v1/Identity/verification/international-passport

Description​

This endpoint is used to verify a person's identity using an international passport.

Headers: Accept-Language: optional, allows changing default response message language, type: string

Content-Type:

  • text/plain
  • application/json
  • text/json

ApiKey:

  • No API key required

Request Body: An object of the PassportRequest schema.

URL: /api/v1/Identity/verification/international-passport

Query Parameters:

  • None

params:

  • version: string, required

Response: The response is a "Success" status with a code of 200.

Schema:

    jsonCopy code{
    "passport_number": "A12345678",
    "first_name": "John",
    "last_name": "Doe",
    "expiry_date": "2024-02-18T12:12:12.000Z",
    "issue_country": "United States"
    }

Error Codes:

  • 400: Bad Request
  • 404: Resource not found
  • 500: Internal server error

Example:

bashCopy codePOST /api/v1/Identity/verification/international-passport
Request Body:
    {
    "passport_number": "A12345678",
    "first_name": "John",
    "last_name": "Doe",
    "expiry_date": "2024-02-18T12:12:12.000Z",
    "issue_country": "United States"
    }

Response:

jsonCopy codeHTTP/1.1 200 OK
    {
    "passport_number": "A12345678",
    "first_name": "John",
    "last_name": "Doe",
    "expiry_date": "2024-02-18T12:12:12.000Z",
    "issue_country": "United States"
    }

Headers​

Accept-Language Change default response message language from English(en). Available languages fr,en Content-Type application/json

Accept text/plain

Body raw(json)​

    {
    "number": "<string>",
    "last_name": "<string>",
    "image": "<string>"
    }